Add a pull request template #17281
Merged
Add a pull request template #17281
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I'm sure we can fill this out with a lot more. For now, though, I just want a non-intrusive way to remind about autofix. Suggestions on other things to add would be appreciated. |
erik-krogh
reviewed
Aug 22, 2024
.github/pull_request_template.md
Outdated
| ### Pull Request checklist | ||
|
|
||
| - [ ] Add a change if necessary. See [the documentation](https://github.com/github/codeql/blob/main/docs/change-notes.md). | ||
| - [ ] If this PR makes any changes to `.ql`, `.qll`, or `.qhelp` files, make sure that autofixes generated based on these changes are valid. See [the documentation](https://github.com/github/codeql-team/blob/main/docs/best-practices/validating-autofix-for-query-changes.md) (internal access required). |
There was a problem hiding this comment.
Suggested change
| - [ ] If this PR makes any changes to `.ql`, `.qll`, or `.qhelp` files, make sure that autofixes generated based on these changes are valid. See [the documentation](https://github.com/github/codeql-team/blob/main/docs/best-practices/validating-autofix-for-query-changes.md) (internal access required). | |
| - [ ] If this PR makes significant changes to `.ql`, `.qll`, or `.qhelp` files, make sure that autofixes generated based on these changes are valid. See [the documentation](https://github.com/github/codeql-team/blob/main/docs/best-practices/validating-autofix-for-query-changes.md) (internal access required). |
aeisenberg
force-pushed
the
aeisenberg/pr-template
branch
from
24415b6 to
c1c9ef2
Compare
erik-krogh
previously approved these changes
Aug 25, 2024
|
Adding codeql Engineering Managers as reviewers since we discussed this PR this morning. |
adityasharad
previously approved these changes
Aug 29, 2024
Co-authored-by: Aditya Sharad <[email protected]>
erik-krogh
previously approved these changes
Aug 30, 2024
|
mentioning @esbena in case this was lost in the notifications maelstrom |
|
I'll keep this open until Tuesday so I can give others a chance to review. |
esbena
reviewed
Sep 2, 2024
.github/pull_request_template.md
Outdated
|
|
||
| #### All query authors | ||
|
|
||
| - [ ] Add a change note if necessary. See [the documentation](https://github.com/github/codeql/blob/main/docs/change-notes.md) in this repository. |
There was a problem hiding this comment.
Inconsistent style. I'm not going to discuss which of the two styles that is preferable.
Suggested change
| - [ ] Add a change note if necessary. See [the documentation](https://github.com/github/codeql/blob/main/docs/change-notes.md) in this repository. | |
| - [ ] Change notes are added if necessary. See [the documentation](https://github.com/github/codeql/blob/main/docs/change-notes.md) in this repository. |
This matches the declarative style of the other bullets, especially "QL tests are added..." one.
.github/pull_request_template.md
Outdated
Comment on lines
12
to
13
| - [ ] If this PR makes significant changes to `.ql`, `.qll`, or `.qhelp` files, make sure that autofixes generated based on these changes are valid. See [the documentation](https://github.com/github/codeql-team/blob/main/docs/best-practices/validating-autofix-for-query-changes.md) (internal access required). | ||
| - [ ] Test your changes [at scale](https://github.com/github/codeql-dca/) (internal access required). |
There was a problem hiding this comment.
These two bullets might need a reformulation to match the style above.
esbena
approved these changes
Sep 4, 2024
erik-krogh
approved these changes
Sep 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a pull request template. It is sparse right now. The main goal is to remind query authors to check for autofix changes when they add new queries or update existing ones.